pp108 : loadAppPaletteContent() Method

loadAppPaletteContent() Method


Loads the HTML content as an appPalette in the specified region. If no region is specified, the appPalette is loaded as a floating object. Once loaded, you can access the appPalette using application.appPalettes collection.

Syntax


application.loadAppPaletteContent(sRegionId, sAppPaletteId, htmlContent, oAppPaletteProperties)

Parameters

Parameter

Description

sRegionId

Required. Refers to the ID of the region where the appPalette is to be loaded. If no region is defined in the application, the appPalette is loaded in the floating mode.

sAppPaletteId

Required. Refers to the ID of the appPalette.

htmlContent

Optional. Refers to the HTML content that is set in the appPalette. It can be either HTML string or HTML element.

oAppPaletteProperties

Optional. Refers to the appPalette properties of the JSON (JavaScript Object Notation) object. It can have the following values:

  • caption: String value.
  • title:trueorfalse. Default value istrue.
  • closable:trueorfalse. Default value istrue.


Return Value


Returns the appPalette container.

Remarks


As the appPalette content is on the same document context as that of the application, it does not contain the isAppPaletteClosable() method and is ignored.

Example

var htmlString = '<div class="taskcontainer" id="test">' + .............................. + '</div>' ;
application.loadAppPaletteContent("testRegion", "htmlPalette", htmlString, {caption : "HTML", title : "true"});

Applies To


application

See Also


AppPalettes, Regions